home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sspevd.z / sspevd
Encoding:
Text File  |  2002-10-03  |  6.4 KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSSSSSPPPPEEEEVVVVDDDD((((3333SSSS))))                                                          SSSSSSSSPPPPEEEEVVVVDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSPEVD - compute all the eigenvalues and, optionally, eigenvectors of a
  10.      real symmetric matrix A in packed storage
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SSPEVD( JOBZ, UPLO, N, AP, W, Z, LDZ, WORK, LWORK, IWORK,
  14.                         LIWORK, INFO )
  15.  
  16.          CHARACTER      JOBZ, UPLO
  17.  
  18.          INTEGER        INFO, LDZ, LIWORK, LWORK, N
  19.  
  20.          INTEGER        IWORK( * )
  21.  
  22.          REAL           AP( * ), W( * ), WORK( * ), Z( LDZ, * )
  23.  
  24. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  25.      These routines are part of the SCSL Scientific Library and can be loaded
  26.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  27.      directs the linker to use the multi-processor version of the library.
  28.  
  29.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  30.      4 bytes (32 bits). Another version of SCSL is available in which integers
  31.      are 8 bytes (64 bits).  This version allows the user access to larger
  32.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  33.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  34.      only one of the two versions; 4-byte integer and 8-byte integer library
  35.      calls cannot be mixed.
  36.  
  37. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  38.      SSPEVD computes all the eigenvalues and, optionally, eigenvectors of a
  39.      real symmetric matrix A in packed storage. If eigenvectors are desired,
  40.      it uses a divide and conquer algorithm.
  41.  
  42.      The divide and conquer algorithm makes very mild assumptions about
  43.      floating point arithmetic. It will work on machines with a guard digit in
  44.      add/subtract, or on those binary machines without guard digits which
  45.      subtract like the Cray X-MP, Cray Y-MP, Cray C-90, or Cray-2. It could
  46.      conceivably fail on hexadecimal or decimal machines without guard digits,
  47.      but we know of none.
  48.  
  49.  
  50. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  51.      JOBZ    (input) CHARACTER*1
  52.              = 'N':  Compute eigenvalues only;
  53.              = 'V':  Compute eigenvalues and eigenvectors.
  54.  
  55.      UPLO    (input) CHARACTER*1
  56.              = 'U':  Upper triangle of A is stored;
  57.              = 'L':  Lower triangle of A is stored.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSPPPPEEEEVVVVDDDD((((3333SSSS))))                                                          SSSSSSSSPPPPEEEEVVVVDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      N       (input) INTEGER
  75.              The order of the matrix A.  N >= 0.
  76.  
  77.      AP      (input/output) REAL array, dimension (N*(N+1)/2)
  78.              On entry, the upper or lower triangle of the symmetric matrix A,
  79.              packed columnwise in a linear array.  The j-th column of A is
  80.              stored in the array AP as follows:  if UPLO = 'U', AP(i + (j-
  81.              1)*j/2) = A(i,j) for 1<=i<=j; if UPLO = 'L', AP(i + (j-1)*(2*n-
  82.              j)/2) = A(i,j) for j<=i<=n.
  83.  
  84.              On exit, AP is overwritten by values generated during the
  85.              reduction to tridiagonal form.  If UPLO = 'U', the diagonal and
  86.              first superdiagonal of the tridiagonal matrix T overwrite the
  87.              corresponding elements of A, and if UPLO = 'L', the diagonal and
  88.              first subdiagonal of T overwrite the corresponding elements of A.
  89.  
  90.      W       (output) REAL array, dimension (N)
  91.              If INFO = 0, the eigenvalues in ascending order.
  92.  
  93.      Z       (output) REAL array, dimension (LDZ, N)
  94.              If JOBZ = 'V', then if INFO = 0, Z contains the orthonormal
  95.              eigenvectors of the matrix A, with the i-th column of Z holding
  96.              the eigenvector associated with W(i).  If JOBZ = 'N', then Z is
  97.              not referenced.
  98.  
  99.      LDZ     (input) INTEGER
  100.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  101.              'V', LDZ >= max(1,N).
  102.  
  103.      WORK    (workspace/output) REAL array,
  104.              dimension (LWORK) On exit, if INFO = 0, WORK(1) returns the
  105.              optimal LWORK.
  106.  
  107.      LWORK   (input) INTEGER
  108.              The dimension of the array WORK.  If N <= 1,               LWORK
  109.              must be at least 1.  If JOBZ = 'N' and N > 1, LWORK must be at
  110.              least 2*N.  If JOBZ = 'V' and N > 1, LWORK must be at least 1 +
  111.              6*N + N**2.
  112.  
  113.              If LWORK = -1, then a workspace query is assumed; the routine
  114.              only calculates the optimal size of the WORK array, returns this
  115.              value as the first entry of the WORK array, and no error message
  116.              related to LWORK is issued by XERBLA.
  117.  
  118.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  119.              On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK.
  120.  
  121.      LIWORK  (input) INTEGER
  122.              The dimension of the array IWORK.  If JOBZ  = 'N' or N <= 1,
  123.              LIWORK must be at least 1.  If JOBZ  = 'V' and N > 1, LIWORK must
  124.              be at least 3 + 5*N.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSPPPPEEEEVVVVDDDD((((3333SSSS))))                                                          SSSSSSSSPPPPEEEEVVVVDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.              If LIWORK = -1, then a workspace query is assumed; the routine
  141.              only calculates the optimal size of the IWORK array, returns this
  142.              value as the first entry of the IWORK array, and no error message
  143.              related to LIWORK is issued by XERBLA.
  144.  
  145.      INFO    (output) INTEGER
  146.              = 0:  successful exit
  147.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  148.              > 0:  if INFO = i, the algorithm failed to converge; i off-
  149.              diagonal elements of an intermediate tridiagonal form did not
  150.              converge to zero.
  151.  
  152. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  153.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  154.  
  155.      This man page is available only online.
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.